Skip to main content
POST
/
v1
/
shipping
/
shipments
/
{id}
/
shipped
Mark Shipment as Shipped
curl --request POST \
  --url https://{base_url_domain}/api/global/v1/shipping/shipments/{id}/shipped \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "primary_tracking_number": "987654321",
  "primary_tracking_description": "FedEx Ground",
  "alternate_tracking_number": "123456789",
  "alternate_tracking_description": "FedEx Alternate",
  "manifest_courier_code": "FEDEX"
}
'
{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid.",
      "details": [
        {
          "key": "hold_until_date",
          "message": "The date must be in the future."
        }
      ]
    }
  ]
}

Authorizations

ā€‹
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

ā€‹
id
integer
required

The id of the referenced Shipment.

Required range: x >= 1

Body

application/json
ā€‹
primary_tracking_number
string

Primary tracking number for the shipment.

Example:

"987654321"

ā€‹
primary_tracking_description
string

Description of the primary tracking number.

Example:

"FedEx Ground"

ā€‹
alternate_tracking_number
string

Alternate tracking number for the shipment.

Example:

"123456789"

ā€‹
alternate_tracking_description
string

Description of the alternate tracking number.

Example:

"FedEx Alternate"

ā€‹
manifest_courier_code
string

Courier code for the manifest.

Example:

"FEDEX"

Response

OK - The operation completed successfully and there is no response body.